[Serializer] Clarifies 'csv_headers' option #14609
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
components/serializer.rst
Outdated
| @@ -897,7 +897,7 @@ Option Description De | |||
| ``csv_escape_char`` Sets the escape character (at most one character) | |||
| ``csv_key_separator`` Sets the separator for array's keys during its ``.`` | |||
| flattening | |||
| ``csv_headers`` Sets the headers for the data ``[]``, inferred from input data's keys | |||
| ``csv_headers`` Sets the order of the header and data columns ``[]``, inferred from input data's keys | |||
There was a problem hiding this comment.
I think I understand the problem you want to fix ... but I'm not sure the fix is correct.
If I read "sets the headers for the data", I think about this:
'csv_headers' => ['Header 1 Name', 'Header 2 Name', '...']But if I read "sets the order of the header and data", I understand it like this:
# header name => header position
'csv_headers' => ['Header 1 Name' => 2, 'Header 2 Name' => 1, '...']Maybe adding a small example could help?
There was a problem hiding this comment.
Thank you for your comments. I added an example, hopefully that will make it more clear.
carsonbot
changed the title
OskarStark
approved these changes
Jan 7, 2021
|
Thank you @lajosthiel and congrats on your first Symfony Docs contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.